Skip to content

Updating the Policy docs for GA release#2938

Merged
shaun-od merged 5 commits into
mainfrom
mas/policies-updates
Nov 27, 2025
Merged

Updating the Policy docs for GA release#2938
shaun-od merged 5 commits into
mainfrom
mas/policies-updates

Conversation

@shaun-od
Copy link
Copy Markdown
Contributor

@shaun-od shaun-od commented Nov 25, 2025

Updated Policies documentation to prepare for general availability release and improved usability with UI editor workflow.

Getting started changes

  • Removed alpha/preview warnings and callouts
  • Updated "Enforceable Policies" section to "What can you enforce with policies?" with expanded use cases
  • Completely rewrote getting started guide to focus on UI editor workflow instead of OCL files
  • Added new sections for committing, publishing, and activating policies through the UI
  • Updated to reflect modern Platform Hub repository setup

Example updates

  • Changed from OCL-file-only format to UI editor-first approach
  • Added "How to use these examples" section explaining both UI editor and OCL file workflows
  • Removed metadata (name, description, violation_reason) from all examples
  • Simplified all examples to show only Rego code blocks suitable for copy-paste into UI editor
  • Split examples into "Scoping examples" and "Conditions examples" sections
  • Changed code block syntax highlighting from rego to ruby

Added new examples:

  • Scope example for excluding specific projects
  • Conditions example for checking no parallel execution
  • Moved OCL file format documentation to end of page as alternative approach
  • Updated package names to match policy slugs consistently

Best practices update:

  • Added new section "Check for parallel execution"
  • Explains StartTrigger property values (StartAfterPrevious vs StartWithPrevious)
  • References examples page for implementation

Added troubleshooting

Documents Windows Server missing Visual C++ Redistributable dependency issue

These changes prepare the Policies documentation for general availability by removing alpha warnings, restructuring examples for better usability with the new UI editor, and adding practical guidance for common use cases.

Copy link
Copy Markdown
Contributor

@denys-octopus denys-octopus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good 👍

Comment thread src/pages/docs/platform-hub/policies/index.md
Comment thread src/pages/docs/platform-hub/policies/index.md Outdated
Comment thread src/pages/docs/platform-hub/policies/index.md Outdated
Comment thread src/pages/docs/platform-hub/policies/index.md
Comment thread src/pages/docs/platform-hub/policies/best-practices.md
Comment thread src/pages/docs/platform-hub/policies/examples.md
@shaun-od shaun-od force-pushed the mas/policies-updates branch from 8286c62 to 7e99188 Compare November 26, 2025 22:26
@shaun-od shaun-od merged commit a99b698 into main Nov 27, 2025
4 checks passed
@shaun-od shaun-od deleted the mas/policies-updates branch November 27, 2025 00:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants